Annotate pure factory functions/calls with PURE / NO_SIDE_EFFECTS#21465
Draft
NullVoxPopuli-ai-agent wants to merge 2 commits into
Draft
Annotate pure factory functions/calls with PURE / NO_SIDE_EFFECTS#21465NullVoxPopuli-ai-agent wants to merge 2 commits into
NullVoxPopuli-ai-agent wants to merge 2 commits into
Conversation
Adds `/* @__PURE__ */` and `/* @__NO_SIDE_EFFECTS__ */` annotations to
ember-source's side-effect-free factory functions and their module-scope
call sites. Rollup/rolldown cannot prove these calls pure on their own
(the callee usually lives in another module), so without the annotation
a single module-scope `Mixin.create(...)`, `X.extend(...)`,
`createPrimitiveRef(...)`, `new Cache(...)`, etc. keeps the whole module
in the consumer's graph.
Annotated, by kind:
- NO_SIDE_EFFECTS on pure factories: createPrimitiveRef + the rest of the
reference constructors (createConstRef/createUnboundRef/createComputeRef/
createReadOnlyRef/createInvokableRef), internalHelper (glimmer + ember),
intern (glimmer + ember), makeDictionary, templateFactory, template.
- PURE on module-scope factory calls: Mixin.create(...) and
FrameworkObject/CoreObject/EmberObject/Service/Namespace.extend(...)
across the mixins, array, controller, engine, enumerable, object,
routing, and ember-testing modules; createPrimitiveRef('ember-view')
in curly; intern(...) for GUID_KEY; the @ember/-internals/string and
dasherize-component-name Caches; @glimmer/program's constants()/indexOf
and DEFAULT_TEMPLATE's JSON.stringify.
These are inert in ember-source's own bundles (its rollup keeps all
module side effects); they only let downstream bundlers — and the
side-effect detection in emberjs#21449 — drop the unused results. The
tree-shakability snapshot gains three newly-shakable entrypoints
(@ember/-internals/container, views/lib/compat/fallback-view-registry,
views/lib/system/utils).
Supersedes the manual annotations in emberjs#21449, which keeps the
side-effect-detection plugin and generated sideEffects list.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
`template()` from @ember/template-compiler calls setComponentTemplate(),
which is the whole point of the common statement-position usage:
class Foo extends GlimmerishComponent {
static {
template('<button {{on "click" this.handleClick}}/>', { component: this });
}
}
Here the result is discarded, so /* @__NO_SIDE_EFFECTS__ */ let the
bundler delete the call entirely — the component never gets its template
and renders nothing. This broke the runtime template compiler suites and
the keyword "no eval and no scope" tests (Cannot read properties of null
(reading 'click')).
Drop the annotation; the function is genuinely effectful.
Contributor
📊 Size reportTarball size — dist/dev 0.05%↑
dist/prod 0.08%↑
smoke-tests/v2-app-hello-world-template/dist -0.58%↓
🤖 This report was automatically generated by wyvox/pkg-size |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
/* @__PURE__ */and/* @__NO_SIDE_EFFECTS__ */annotations to ember-source's side-effect-free factory functions and their module-scope call sites.Rollup/rolldown can't prove these calls pure on their own — the callee almost always lives in another module — so a single module-scope
Mixin.create(...),X.extend(...),createPrimitiveRef(...),new Cache(...), etc. is enough to drag the whole module into a consumer's graph. The annotation removes that anchor.What's annotated
@__NO_SIDE_EFFECTS__on pure factory definitions@glimmer/reference:createPrimitiveRef+createConstRef/createUnboundRef/createComputeRef/createReadOnlyRef/createInvokableRefinternalHelper(glimmer + ember),intern(glimmer + ember),makeDictionarytemplateFactory(@glimmer/opcode-compiler),template(@ember/template-compiler)@__PURE__on module-scope factory callsMixin.create(...)andFrameworkObject/CoreObject/EmberObject/Service/Namespace.extend(...)across the runtime/views mixins,@ember/array,@ember/controller,@ember/engine,@ember/enumerable,@ember/object,@ember/routing, andember-testingcreatePrimitiveRef('ember-view')in the curly component managerintern(...)forGUID_KEY@ember/-internals/stringanddasherize-component-nameCaches@glimmer/program'sconstants()/.indexOf()andDEFAULT_TEMPLATE'sJSON.stringifySafety
These are inert in ember-source's own builds — our rollup config keeps all module side effects (
moduleSideEffects: true), so dist/dev and dist/prod are byte-for-byte equivalent in behavior. They only give downstream bundlers (and the side-effect detection in #21449) permission to drop the results when they're unused. Every annotated call is a pure value factory whose result is referenced whenever the module is actually used, so a consumer that keeps the binding keeps the call.Effect
tree-shakabilitysnapshot gains three newly-shakable entrypoints:@ember/-internals/container,@ember/-internals/views/lib/compat/fallback-view-registry,@ember/-internals/views/lib/system/utils.sideEffectslist (e.g.curly,@ember/-internals/string,@glimmer/program).Relationship to other PRs
This supersedes the manual source annotations in #21449 and broadens them; #21449 keeps the side-effect-detection plugin and the generated
sideEffectslist. It composes with the renderer/classic-cleanup refactors (#21463 / #21464) — the remaining hello-world weight (classicComponent,EmberObject,computed, …) is held in byreopen()/ manager-registration patterns that those PRs address, not by anything annotations can reach.🤖 Generated with Claude Code